home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / gui / bgui11b.lha / docs / pageclass.doc < prev    next >
Encoding:
Text File  |  1995-01-03  |  2.7 KB  |  87 lines
  1.  
  2.            $RCSfile: pageclass.doc,v $
  3.         Description: Pageclass documentation.
  4.           Copyright: (C) Copyright 1994 Jaba Development.
  5.                      (C) Copyright 1994 Jan van den Baard.
  6.                      All Rights Reserved.
  7.  
  8.             $Author: jaba $
  9.           $Revision: 1.2 $
  10.               $Date: 1994/10/23 14:44:33 $
  11. ------------------------------------------------------------------------------
  12.  
  13. TABLE OF CONTENTS
  14.  
  15. pageclass/--background--
  16. pageclass/Methods
  17. pageclass/Attributes
  18.  
  19. pageclass/--background--                              pageclass/--background--
  20.  
  21.     NAME
  22.         Class:          pageclass
  23.         Superclass:     baseclass
  24.         Include File:   <libraries/bgui.h>
  25.  
  26.     FUNCTION
  27.         To  provide   a gadget which can keep track of "pages" of gadgets from
  28.         which one is displayed at the time. The pages can contain a groupclass
  29.         object which has a set of members or it can contain a single gadget.
  30.  
  31.         Object  from  this  class  sends  out the following attribute pairs in
  32.         their notification events:
  33.  
  34.         PAGE_Active     - Currently active page number.
  35.  
  36. pageclass/Methods                                            pageclass/Methods
  37.  
  38.     NEW METHODS
  39.         None.
  40.  
  41.     CHANGED METHODS
  42.         OM_DISPOSE -- When this method is called it will also  dispose  of all
  43.                 pages of objects attached to this object.
  44.  
  45. pageclass/Attributes                                      pageclass/Attributes
  46.  
  47.     NAME
  48.         PAGE_Member -- ( Object * )
  49.  
  50.     FUNCTION
  51.         To add a page of gadgets. The object may be a groupclass object having
  52.         any number of members or it may be a single gadget object.
  53.  
  54.         Default is NULL. Applicability is (I).
  55.  
  56.     NAME
  57.         PAGE_Active -- ( ULONG )
  58.  
  59.     FUNCTION
  60.         Set the page number  currently  active (I.E. displayed on the window).
  61.         The active page is the only page that can receive input.
  62.  
  63.         Default 0. Applicability is (ISGNU).
  64.  
  65.     NAME
  66.         PAGE_NoBufferRP -- ( BOOL )
  67.  
  68.     FUNCTION
  69.         When this  attribute is  set  to  TRUE the  pageclass  will  tell  the
  70.         layout engine not to  setup a  buffer  RastPort  which  means that all
  71.         rendering occures  on-screen.   This may be handy when you use objects
  72.         which  take  some  time  to  render  like the colorwheel.gadget on 256
  73.         colour screens.
  74.  
  75.         Default is FALSE. Applicability is (I).
  76.  
  77.     NAME
  78.         PAGE_Inverted -- ( BOOL )
  79.  
  80.     FUNCTION
  81.         To force the members added at create time  to be  AddHead()'ed  to the
  82.         member  list  instead  of  AddTail()'ed.   This  is  necessary for the
  83.         assembly macros of the BGUI package.
  84.  
  85.         Default is FALSE. Applicability is (I).
  86.  
  87.